-
Notifications
You must be signed in to change notification settings - Fork 453
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] Configuration and component section overhaul #3324
Conversation
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
17cb7f3
to
3113451
Compare
Probably easiest to look at the preview for review… |
@nbroyles Should this also be removed? m3/site/content/includes/m3query/annotated_config.yaml Lines 64 to 67 in 3113451
|
Yup. You can also remove this: m3/site/content/includes/m3query/annotated_config.yaml Lines 198 to 209 in 3113451
|
Codecov Report
@@ Coverage Diff @@
## master #3324 +/- ##
=========================================
- Coverage 72.4% 72.4% -0.1%
=========================================
Files 1100 1100
Lines 102443 102443
=========================================
- Hits 74190 74187 -3
+ Misses 23155 23153 -2
- Partials 5098 5103 +5
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
…ischinch/config-docs
Ready for a final review @robskillington and also bringing in @wesleyk here for some input… A couple of notes after many conversations with Rob… The m3dbnode config is pretty solid and mostly understandable. The M3 Query/Coordinator config isn't, and is still quite confusing, mostly as there seem some discrepancies between the way config works between m3dbnode setups and separated node clusters. This is something that need resolving in the code base but also docs changes from here on in at a higher level will attempt to clarify the differences in context of implementation. |
Signed-off-by: ChrisChinchilla <[email protected]>
eba5d2b
to
ef16789
Compare
Overall I think this is looking really good. I do have one major concern though having reviewed the documentation preview a few times, I think that "Architecture" is now really hard to find. You don't really expect to have "Architecture" under "Reference". I believe actually it would be more discoverable/obvious if we did the following and split them and make them separate top level entries "Reference & Config" (to make it obvious to find config file explanations here) and "Architecture":
|
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: ChrisChinchilla <[email protected]>
This PR does two things…